<div class="refentry" lang="en" xml:lang="en"><a id="glClearStencil"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glClearStencil — specify the clear value for the stencil buffer</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><p><code class="funcdef">void <b class="fsfunc">glClearStencil</b>(</code>GLint <var class="pdparam">s</var><code>)</code>;</p></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>s</code></em></span></dt><dd><p>
                    Specifies the index used when the stencil buffer is cleared.
                    The initial value is 0.
                </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
            <code class="function">glClearStencil</code> specifies the index used by <a href="glClear"><span class="citerefentry"><span class="refentrytitle">glClear</span></span></a> to clear the stencil buffer.
            <em class="parameter"><code>s</code></em> is masked with
            <math overflow="scroll">

                <mrow>
                    <msup><mn>2</mn>
                    <mi mathvariant="italic">m</mi>
                    </msup>
                    <mo>-</mo>
                    <mn>1</mn>
                </mrow>
            </math>,
            where
            <math overflow="scroll"><mi mathvariant="italic">m</mi></math>
            is the number of bits in the stencil buffer.
        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
            <a href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_STENCIL_CLEAR_VALUE</code>
        </p><p>
            <a href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_STENCIL_BITS</code>
        </p></div>
        {$pipelinestall}{$examples}
        <div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
            <a href="glClear"><span class="citerefentry"><span class="refentrytitle">glClear</span></span></a>,
            <a href="glStencilFunc"><span class="citerefentry"><span class="refentrytitle">glStencilFunc</span></span></a>,
            <a href="glStencilFuncSeparate"><span class="citerefentry"><span class="refentrytitle">glStencilFuncSeparate</span></span></a>,
            <a href="glStencilMask"><span class="citerefentry"><span class="refentrytitle">glStencilMask</span></span></a>,
            <a href="glStencilMaskSeparate"><span class="citerefentry"><span class="refentrytitle">glStencilMaskSeparate</span></span></a>,
            <a href="glStencilOp"><span class="citerefentry"><span class="refentrytitle">glStencilOp</span></span></a>,
            <a href="glStencilOpSeparate"><span class="citerefentry"><span class="refentrytitle">glStencilOpSeparate</span></span></a>
        </p></div><div class="refsect1" lang="en" xml:lang="en"><div id="Copyright"><h2>Copyright</h2><p>
            Copyright © 1991-2006
            Silicon Graphics, Inc. This document is licensed under the SGI
            Free Software B License. For details, see
            <a href="https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/" target="_top">https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/</a>.
        </p></div></div></div>
